home *** CD-ROM | disk | FTP | other *** search
/ Oh!X 2000 Spring / Oh!X 2000 Spring Special CD-ROM (Japan) (Part 2).7z / Oh!X 2000 Spring Special CD-ROM (Japan) (Part 2).bin / DXF / samples / multimedia / dxreadme.txt
Text File  |  1999-08-20  |  9KB  |  260 lines
  1. //-----------------------------------------------------------------------------
  2. // File: DXReadme.txt
  3. //
  4. // Desc: Readme file for the DirectX SDK samples directory
  5. //
  6. // Copyright (c) 1998-1999 Microsoft Corporation. All rights reserved.
  7. //-----------------------------------------------------------------------------
  8.  
  9. This directory structure contains all the samples for the DirectX SDK.
  10.  
  11.  
  12. The samples are organized by component, where appropriate. For example, samples
  13. specific to one component can be found in the following sub-directories:
  14.         D3DIM     - Direct3D immediate-mode samples
  15.         D3DRM     - Direct3D retained-mode samples
  16.         D3DX      - D3DX samples
  17.         DDraw     - DirectDraw samples
  18.         DInput    - DirectInput samples
  19.         DMusic    - DirectMusic samples
  20.         DPlay     - DirectPlay samples
  21.         DSound    - DirectSound samples
  22.         DXMisc    - Miscellaneous code and libraries (DSetup sample)
  23.         VBSamples - DirectX samples for Visual Basic
  24.  
  25. Some of the these directories, such as D3DIM, are broken down even further, 
  26. due to the large number of samples for those components. Please see
  27. the readme.txt files in the individual directories for more information.
  28.  
  29.  
  30. HOW TO BUILD
  31. ------------
  32. All SDK samples are designed to be built in the directory they are in. Just
  33. ensure that your Win32 development environment is set up, and you can go to
  34. any sample directory and do a make (or nmake).
  35.  
  36. To set up your development environment to build the sample apps, modify the 
  37. DXSETENV.BAT file, which can be found in your \mssdk\bin directory, to point
  38. to your development tools, and execute that batch file.
  39.  
  40. NOTE: A "Too many parameters" error may happen if your path is over 128
  41. characters as a result of running DXSETENV.BAT after VCVARS32.BAT.  A method
  42. of resolving this is to reduce the amount of information on your path to the
  43. minimum needed.
  44.  
  45. There is a main make file in each sample directory called "MAKEFILE" which is
  46. for use with Microsoft VC++ 2.0 or higher (NMAKE), Watcom C\C++ 10.6 or higher
  47. (NMAKE CLONE), or Borland CBuilder3 or compatible compiler (MAKE).
  48.  
  49. There are 2 ways to build each sample, debug or retail.  To build a sample as
  50. retail, just type:
  51.  
  52. nmake nodebug=1
  53.  
  54. To build a sample as debug, just type:
  55.  
  56. nmake
  57.  
  58. To first remove all object files before doing a build, use:
  59.  
  60. nmake clean
  61.  
  62. Or:
  63.  
  64. nmake clean nodebug=1
  65.  
  66. There is also a master make file in the each sample category directory that will
  67. compile all the samples at once called "DXALL.MAK" which is for use with Microsoft
  68. VC++ 2.0 or higher (NMAKE) or Watcom C\C++ 10.6 or higher (NMAKE CLONE).
  69.  
  70. In order to use the build all makefiles, the following command line should be
  71. used:
  72.  
  73. nmake /fdxall.mak /a                   (Builds all debug files)
  74.  
  75. Other examples:
  76.  
  77. nmake /fdxall.mak /a clean=1           (Removes all debug files)
  78. nmake /fdxall.mak /a clean=1 nodebug=1 (Removes all release files)
  79. nmake /fdxall.mak /a nodebug=1         (Release build)
  80.  
  81.  
  82. NOTES FOR USERS OF VISUAL C++
  83. -----------------------------
  84. In each sample directory there is also a .MDP project file that is compatible
  85. with Microsoft Visual C++ 4.2 or higher.
  86.  
  87. Visual C++ 4.2 or greater includes the DX2 header files and libraries.  Make
  88. sure to set the DirectX include and library paths to be BEFORE the VC library
  89. and include paths inside the IDE environment, which can be found under the
  90. Tools menu, Options... dialog, Directories tab.
  91.  
  92.  
  93. NOTES FOR USERS OF WATCOM C/C++
  94. -------------------------------
  95. Watcom C/C++ v10.6 is required to compile the DXSDK samples, v10.0 is not
  96. sufficient.
  97.  
  98. The makefiles expect the WATCOM environment variable to be set, as it should
  99. have been by the Watcom installation procedure.
  100.  
  101. In order to use any of the makefiles you must use the Watcom NMAKE clone, and
  102. follow the same instructions for the command line as with VC++.
  103.  
  104. Watcom and Watcom C/C++ are trademarks of Powersoft, Watcom Division.
  105.  
  106.  
  107. NOTES FOR USERS OF BORLAND CBUILDER3 OR COMPATIBLE
  108. --------------------------------------------------
  109. The makefiles expect the BORLAND environment variable to be set.
  110.  
  111. The master makefiles will NOT work with Borland.
  112.  
  113. CBuilder is a trademark of Borland International, Inc.
  114.  
  115. NOTES FOR D3DIM SAMPLES
  116. -----------------------
  117.  
  118. Release Notes for Samples:
  119.  
  120. General:
  121.  
  122.     These samples are based on a common framework provided in the D3DFrame
  123. directory.  This framework is intended to conceal most of the initialization
  124. work so that the technique being demonstrated is clearly shown.  This
  125. framework does not necessarily represent the optimal initialization code for
  126. a major application.
  127.  
  128.     The samples do not currently operate in 8-bit screen depths.
  129.  
  130.     Some samples require features that may not be present on your
  131. current hardware.  To see the effect of these features, the reference
  132. rasterizer may be selected, *however it is not enabled by default.*
  133. A registry key required to enable it and utility .reg files have
  134. been provided in the bin directory for this purpose.
  135.  
  136.  
  137. Commands:
  138.         <F1>            About, this list of commands
  139.         <F2>            Change Device Dialog
  140.                 Device
  141.                 Display Mode (these are stored per device)
  142.         <Alt-Enter>     Toggle full-screen/windowed operation
  143.         <Esc>           Exit
  144.  
  145.  
  146. Sample Descriptions:
  147.  
  148. For detailed information on a particular sample see the readme.txt in each samples'
  149. \src folder.
  150.  
  151.     Bend
  152.         Demonstrates drawprimitive with a simple technique for smooth
  153.         skinning of a joint between two segments.
  154.  
  155.     BillBoard
  156.     Demonstrates colorkey for both objects and their shadows.
  157.  
  158.     Boids
  159.     Demonstrates DrawPrim usage
  160.  
  161.     Bump Earth
  162.     Demonstrates the usage of the BUMPENVMAP bump mapping approach.
  163.     Try using other images in earthenvmap.bmp to simulate different
  164.     number/colors of light sources.  16x16 textures work fine.
  165.  
  166.     Bump Waves
  167.     Another bump mapping sample.
  168.  
  169.     Clip Mirror
  170.     Demonstrates usage of custom-defined clipping planes.
  171.  
  172.     Compress
  173.     Demonstrates how to load a DDS texture file and deal with DXTN-compressed
  174.     surfaces.
  175.  
  176.     Dolphin
  177.     Demonstrates mesh blending.
  178.  
  179.     EnumTex
  180.     Demonstrates how to properly enumerate texture formats.
  181.  
  182.     Environment Cube
  183.     Shows how to set up dynamic cubic environment mapping.
  184.  
  185.     Filter
  186.     Demonstrates quality differences in different texture filtering methods.
  187.     Currently both objects are rendered using the current device.
  188.     Known issue:  Sample never sets max anisotropy high enough for
  189.               anisotropic filtering to kick in.
  190.  
  191.     Fireworks
  192.     Cool demo.
  193.  
  194.     Flare
  195.     How to add lens flare to just about anything.
  196.  
  197.     Light Map
  198.     Shows how to implement light maps via multitexture.
  199.  
  200.     Lights
  201.     Demonstrates use of the various Direct3D light source types.
  202.  
  203.     MFC Fog
  204.     Demonstrates Direct3D geometry pipeline's vertex fog, and how to use MFC
  205.     with Direct3D.
  206.  
  207.     MFCTex
  208.         Tool written in MFC, used to interactively play with Direct3D's
  209.         multitexturing API.
  210.  
  211.     MipMap
  212.     Demonstrates/tests mip mapping capabilities
  213.     Image on left is not mipmapped, image on right is.
  214.  
  215.     MultiTexture
  216.     Demonstrates a dual texture technique of applying a light map to a
  217.         base texture.
  218.  
  219.         There is a bug in certain Rage II drivers where the driver uses the 
  220.         MODULATE blend mode even when DECAL is requested.  This causes the 
  221.         sample to render all black when running on HAL on this driver.
  222.  
  223.     Screen Saver
  224.     Shows how to write a screen saver that uses D3D.
  225.  
  226.     Shadow Volume
  227.     Demonstrates use of stencil buffers to display real-time shadows cast
  228.         on arbitrary surfaces.  This requires the software rasterizers or hardware
  229.         supporting stencil buffers.  Other hardware will not appear in the dialog.
  230.  
  231.     Shadow Volume 2
  232.         This sample demonstrates more sophisticated shadowing techniques that
  233.     require more than one bit of stencil buffer, such as when object shadows
  234.     are intersecting.  This source code does not demonstrate ideal usage of
  235.     the API for applications beyond visual demonstrations.
  236.  
  237.     Sphere Map
  238.     Shows how to use a spherical environment map.
  239.  
  240.     Stencil Depth
  241.     Shows how to use the stencil buffer to measure depth complexity.
  242.  
  243.     Stencil Mirror
  244.     Shows how to use the stencil buffer to create a mirror.
  245.  
  246.     Vertex Buffer
  247.     Demonstrates a usage scenario for vertex buffers.
  248.  
  249.     Video Texture
  250.     Shows how to use an AVI as a texture map.
  251.  
  252.     W-Buffer
  253.     Demonstrates eye-relative z-buffering.  This requires either the
  254.         Reference Software rasterizer or hardware that supports this technique.
  255.         Other hardware (and the std software device) will not appear in the dialog.
  256.  
  257.     X File
  258.     Shows how to load an "X" file in D3D Immediate Mode.
  259.  
  260.